LotusScript Doc

Class: LSAPostalAddressItem

Represents a postal address consisting of a key for the access and attribute which describe the postal address. This class can be used together with the class LSANamedList and implemets the AnyItem interface.

Author:
LPS EMEA
Version:
1.2, 24.MAR.2000



Property Summary
Public Property Set Building As String
Public Property Get Building As String
Public Property Set CareOfName As String
Public Property Get CareOfName As String
Public Property Set City As String
Public Property Get City As String
Public Property Set Country As String
Public Property Get Country As String
Public Property Set Delimiter As String
Public Property Get Delimiter As String
Public Property Get DisplayFormat As String
Public Property Set DisplayFormat As String
Public Property Get Formatted As String
Public Property Set Key As String
Public Property Get Key As String
Public Property Set NotAllowedChars As Variant
Public Property Get NotAllowedChars As Variant
Public Property Set Postbox As String
Public Property Get Postbox As String
Public Property Set Room As String
Public Property Get Room As String
Public Property Set State As String
Public Property Get State As String
Public Property Set Street As String
Public Property Get Street As String
Public Property Set StreetNo As String
Public Property Get StreetNo As String
Public Property Set Zip As String
Public Property Get Zip As String

Method Summary
Sub Clear ()
Function CompareTo (CompItem As LSAPostalAddressItem) As Integer
Sub Delete ()
Sub Explode (serializedObj As String)
Function hasAttributeChanged (attrName As String) As Integer
Function hasChanged () As Integer
Function Implode () As String
Function IsEmptyInstance () As Integer
Sub New (NewKey As String, NewCareOfName As String, NewBuilding As String, NewRoom As String, NewStreet As String, NewStreetNo As String, NewPostBox As String, NewZip As String, NewCity As String, NewCountry As String, NewState As String)
Sub Validate ()

Property Detail

Public Property Set Key AsString

Sets the description for the postal address; e.g. "Office" for the postal address of the office a person is working at.

Errors:
ErrDelimiterInField
Summmary Top

Public Property Get Key AsString

Summmary Top

Public Property Set CareOfName AsString

Sets the care of name for the postal address and checks on not allowed characters.

Errors:
ErrDelimiterInField
Summmary Top

Public Property Get CareOfName AsString

Summmary Top

Public Property Set Building AsString

Sets the building information of a postal address

Errors:
ErrDelimiterInField
Summmary Top

Public Property Get Building AsString

Summmary Top

Public Property Set Room AsString

Sets the room information of a postal address

Errors:
ErrDelimiterInField
Summmary Top

Public Property Get Room AsString

Summmary Top

Public Property Set Street AsString

Sets the street information of a postal address

Errors:
ErrDelimiterInField
Summmary Top

Public Property Get Street AsString

Summmary Top

Public Property Set StreetNo AsString

Sets the identification number in the street.

Errors:
ErrDelimiterInField
Summmary Top

Public Property Get StreetNo AsString

Summmary Top

Public Property Set Postbox AsString

Sets the postbox information of a postal address.

Errors:
ErrDelimiterInField
Summmary Top

Public Property Get Postbox AsString

Summmary Top

Public Property Set Zip AsString

Sets the post code and postal routing number information of a postal address.

Errors:
ErrDelimiterInField
Summmary Top

Public Property Get Zip AsString

Summmary Top

Public Property Set City AsString

Sets the city information of a postal address

Errors:
ErrDelimiterInField
Summmary Top

Public Property Get City AsString

Summmary Top

Public Property Set Country AsString

Sets the country information of a postal address

Errors:
ErrDelimiterInField
Summmary Top

Public Property Get Country AsString

Summmary Top

Public Property Set State AsString

Sets the state information of a postal address

Errors:
ErrDelimiterInField
Summmary Top

Public Property Get State AsString

Summmary Top

Public Property Set Delimiter AsString

When the object is imploded to a serial data string this character is used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get Delimiter AsString

Summmary Top

Public Property Set NotAllowedChars AsVariant

These characters are not allowed to use in the postal address properties which are used in the serial format

Summmary Top

Public Property Get NotAllowedChars AsVariant

Summmary Top

Public Property Get DisplayFormat AsString

Summmary Top

Public Property Set DisplayFormat AsString

A rule for formatting the object data when the property 'Formatted' is used. The values of the constants DefaultName have to be used to form the format.

Summmary Top

Public Property Get Formatted AsString

Formats the object's data in a user defined way

Summmary Top
Method Detail

New

Public Sub New(NewKey As String,NewCareOfName As String,NewBuilding As String,NewRoom As String,NewStreet As String,NewStreetNo As String,NewPostBox As String,NewZip As String,NewCity As String,NewCountry As String,NewState As String)
Summmary Top

Delete

Public Sub Delete
Summmary Top

Implode

Public Function Implode As String
Writes the data of the object to a serialized data string. The string should be of the form with "~" as seperator: ~~~~~~~~ ~~~~~. @returns String serial data representation of object

Summmary Top

Explode

Public Sub Explode(serializedObj As String)
Transforms a string build by the implode method in its components. The string should be in the form (with "~" as seperator): '~~~~~~~~ '~~~~~ or '~~~~~~~~ '~~~~.

Parameters:
serializedObjStringserial representation of the object
Errors:
ErrDataDoesntCorrespondToObject
Summmary Top

Validate

Public Sub Validate
The validate method checks that the property "Key" isn't empty.

Errors:
null
Summmary Top

Clear

Public Sub Clear
Clears the values of the postaladdress item object. After the usage of clear the method IsEmptyInstance will deliver true as return value.

Summmary Top

IsEmptyInstance

Public Function IsEmptyInstance As Integer
The method checks if all attributes are empty strings. @returns Boolean true, if all attribute types are empty

Summmary Top

CompareTo

Public Function CompareTo(CompItem As LSAPostalAddressItem) As Integer
Compares the properties PostalAddressItem object with another object of same type @returns Boolean true, if all properties are equal

Summmary Top

hasAttributeChanged

Public Function hasAttributeChanged(attrName As String) As Integer
Checks if the attribute with the name attrName has heen changed

Parameters:
attrNameStringthe name of the attribute to check
Returns:
booleantrue, if the attribute has changed
Summmary Top

hasChanged

Public Function hasChanged As Integer
Checks one of the objects attributes has been changed

Summmary Top

TopLotusScript Doc
© Lotus Professional Services
generated on : 05-Apr-01 8:40:00 AM